Payments Page Integration – Implementation

3.13 Cancel Pre–Auth API

This API call is mandatory if Pre-Authorisation has been requested but the transaction has not been settled for some reason (TransactionType 02),
in order to release those funds from the customer's credit card.
Merchant who wants to cancel a pre–auth done by a customer.
Calling the endpoint with the required data will trigger a cancel with the relevant bank and reverse the reserved transaction request with the relevant bank.
(by issuing a 420 instruction).
The endpoint requires Basic Auth (See Appendix I).

Table 27. Cancel Pre–Auth API endpoints
URL Type	URL Value
Test (QA) Post Page	https://qa.vodacompaymentgateway.co.za/api/pay/transaction/cancel/{transactionId}
Live (PROD) Post Page	https://psp.vodacompaymentgateway.co.za/api/pay/transaction/cancel/{transactionId}

Table 28. Cancel Pre–Auth API endpoint url property
Field Name (Case–Sensitive)	Type	Required Mandatory Optional	Description
TransactionId	String	M	Trassmart transaction id for the original transaction settled in Transsmart.

The response of the API request will indicate 200(Ok) on successful cancel pre–auth request.
If the request fails either a 400(Bad request), 500(Server Error) or 401(Unauthorized) will be returned depending on the cause of the error.
500 indicating the bank did not accept the cancel request.